'\" te
.\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH SIP_PARSE_URI 3SIP "November 22, 2021"
.SH NAME
sip_parse_uri, sip_free_parsed_uri \- parse a URI and free a parsed URI
.SH SYNOPSIS
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
#include <sip.h>

\fBsip_uri_t\fR \fIsip_parse_uri\fR(\fBsip_str_t *\fR\fIuri_str\fR,
     \fBint *\fR\fIerror\fR);
.fi

.LP
.nf
\fBvoid\fR \fIsip_free_parsed_uri\fR(\fBsip_uri_t\fR \fIsip_uri\fR);
.fi

.SH DESCRIPTION
For functions that return a pointer of type \fIsip_str_t\fR, \fIsip_str_t\fR is
supplied by:
.sp
.in +2
.nf
typedef struct sip_str {
     char *sip_str_ptr;
     int  sip_str_len;
}sip_str_t;
.fi
.in -2

.sp
.LP
The \fIsip_str_ptr\fR parameter points to the start of the returned value and
\fIsip_str_len\fR supplies the length of the returned value.
.sp
.LP
For example, given the following request line in a \fBSIP\fR message input to
\fBsip_get_request_uri_str()\fR:
.sp
.in +2
.nf
INVITE sip:marconi@example.org SIP/2.0
.fi
.in -2

.sp
.LP
the return is a pointer to \fIsip_str_t\fR with the \fIsip_str_ptr\fR member
pointing to "\fBs\fR" of \fBsip:marconi@example.org\fR and \fIsip_str_len\fR
being set to \fB23\fR, the length of \fBsip:marconi@example.org\fR.
.sp
.LP
The \fBsip_parse_uri()\fR function takes a \fBURI\fR string in the form
\fIsip_str_t\fR and returns a parsed \fBURI\fR \fIsip_uri\fR. The syntax of the
\fBURI\fR is as specified in RFC 3261, section 25.1. If the parser encounters
an error when parsing a component, it sets the appropriate error bit in the
error flags and proceeds to the next component, if present.
.sp
.LP
The \fBsip_free_parsed_uri()\fR function takes a parsed \fBURI\fR
\fIsip_uri\fR, obtained from \fBsip_parse_uri()\fR, and frees any associated
memory.
.SH RETURN VALUES
The \fBsip_parse_uri()\fR function returns the parsed \fBURI\fR \fIsip_uri\fR
on success. It returns a \fBNULL\fR if memory cannot be allocated for the
parsed \fBURI\fR.
.sp
.LP
The value of \fBerrno\fR is not changed by these calls in the event of an
error.
.SH ERRORS
If the error is non-null, the following values is set:
.sp
.ne 2
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
The \fBSIP\fR header value of the \fBSIP\fR message is \fBNULL\fR or there is
no \fBURI\fR.
.sp
The input \fBURI\fR is null or the requested \fBURI\fR component is invalid.
The error flag is set for the requested component.
.sp
The \fBURI\fR parameters or headers are requested from a non-\fBSIP[S]\fR
\fBURI\fR; or the '\fBopaque\fR', '\fBquery\fR', '\fBpath\fR', '\fBreg-name\fR'
components are requested from a \fBSIP[S]\fR \fBURI\fR.
.RE

.sp
.LP
On success, the value of the location pointed to by \fIerror\fR is set to
\fB0\fR.
.SH ATTRIBUTES
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
_
MT-Level	MT-Safe
.TE

.SH SEE ALSO
.BR libsip (3LIB)
